//  Copyright 2012 David Ekholm, jAlbum AB
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.package net.jalbum.editor;

package net.jalbum.injector;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Specifies a named command line argument of the form -name or -name value
 * @author david
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Switch {
    /**
     * Name to use instead of field name
     */
    String name() default "";
    /**
     * Unix like one-character short form
     */
    char alias() default '-';
    /**
     * Text that describes the functionality of this switch
     */
    String description() default "";
    /**
     * States that this switch has to be specified
     */
    boolean mandatory() default false;
    /**
     * Comma separated list of switches that may not appear together with this switch
     */
    String disallow() default "";
    /**
     * Comma separated list of switches that need to appear together with this switch
     */
    String require() default "";
}
